home *** CD-ROM | disk | FTP | other *** search
/ Freelog 45 / Freelog045.iso / Bas / Internet / VisitURL / setup.exe / {app} / template.txt < prev    next >
Text File  |  2002-10-26  |  3KB  |  96 lines
  1. TEMPLATE
  2. --------
  3.  
  4. The template must be a well-formed HTML document.
  5. All tokens must be in UPPERCASE. All tokens begin
  6. and end with tweo underscore characters "__".
  7.  
  8. GENERAL TOKEN DESCRIPTION:
  9. --------------------------
  10.  
  11. __LINK__
  12. Replaced with the actual HTML link
  13. (i.e. URL with its associated description,
  14. and optionally date). This token should
  15. only occur ONCE, in the <BODY> section
  16. of the template
  17. (See section entitled "__LINK__ TOKEN SYNTAX" below in this file.)
  18.  
  19. __URLCOUNT__
  20. Replaced with the number of URLs stored.
  21.  
  22. __GENDATE__
  23. Replaced with the date the HTML file was saved.
  24.  
  25. __GENTIME__
  26. Replaced with the time the HTML file was saved.
  27.  
  28. __TITLE__
  29. Replaced with the "HTML Title" string (you can set it in
  30. program Options, "Files" tab, "Title for the HTML file"
  31. edit box).
  32.  
  33.  
  34. __LINK__ TOKEN SYNTAX
  35. ---------------------
  36.  
  37. This token is expanded to another string of tokens:
  38. __URLLINK__
  39.     (the actual URL, e.g. "http://www.example.com")
  40. __URLDESC__
  41.     (the description string, e.g. "Example website".
  42.     If description is empty, URL is used instead.)
  43. __URLDESC!__
  44.     (the description string, included ONLY if the
  45.     description is non-empty. Otherwise the token
  46.     is discarded and no text is put in its place)
  47. __URLDATE__
  48.     (the date the URL was added to the Visit list)
  49.  
  50. By default, the __LINK__ token is expanded to:
  51.     <A HREF="__URLLINK__">__URLDESC__</A>
  52.  
  53. If you want to change it, edit the first line of the
  54. template, where this format is defined. Please note
  55. how the first line in the sample template provided
  56. with the program is formatted:
  57. <!--#tokens and text#-->
  58. This is an HTML comment. The actual text must be
  59. contained between two hash characters (#). The
  60. whole string can span over several lines, but it MUST
  61. begin with "<!--#" and end with "#-->" (no quotes).
  62. To be valid, the string MUST contain at least the
  63. __URLLINK__ token (without it, the whole file
  64. would be useless, as there would be no place to save
  65. the URL links!).
  66.  
  67. It is OK to use the same token more than once, e.g.
  68.     <A HREF="__URLLINK__">__URLLINK__</A>
  69. if you don't want to see the descriptions in the HTML file.
  70. Another example:
  71.     <A HREF="__URLLINK__">__URLLINK__</A><BR>(__URLDESC__; __URLDATE__)
  72. Try these and see what happens. Remember to wrap these
  73. examples with the comment delimiters and hashes:
  74. <!--#<A HREF="__URLLINK__">__URLLINK__</A>#-->
  75.  
  76. Example of how the __LINK__ definition can span multiple lines:
  77. <!--#
  78. <P>
  79. <A HREF="__URLLINK__">__URLLINK__</A><BR>
  80. <I>__URLDESC__</I>
  81. </P>
  82. #-->
  83.  
  84. Note: Do NOT place the above three tokens in the
  85. body of the template. They have no meaning there.
  86. They are only used to form the proper __LINK__ token.
  87.  
  88. See also: sample template included with the program
  89. distribution (template.tpl).
  90.  
  91. Questions? Suggestions? Email me at:
  92. marek jedlinski
  93. <marekjed@pobox.com>
  94. No HTML-formatted email please!
  95.  
  96.